/*********************************************************************************
 *                                                                               *
 * The MIT License (MIT)                                                         *
 *                                                                               *
 * Copyright (c) 2015-2023 aoju.org and other contributors.                      *
 *                                                                               *
 * Permission is hereby granted, free of charge, to any person obtaining a copy  *
 * of this software and associated documentation files (the "Software"), to deal *
 * in the Software without restriction, including without limitation the rights  *
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell     *
 * copies of the Software, and to permit persons to whom the Software is         *
 * furnished to do so, subject to the following conditions:                      *
 *                                                                               *
 * The above copyright notice and this permission notice shall be included in    *
 * all copies or substantial portions of the Software.                           *
 *                                                                               *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR    *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,      *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER        *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN     *
 * THE SOFTWARE.                                                                 *
 *                                                                               *
 ********************************************************************************/
package org.aoju.bus.core.io.file;

import org.aoju.bus.core.exception.InternalException;
import org.aoju.bus.core.io.file.visitor.MoveVisitor;
import org.aoju.bus.core.lang.Assert;
import org.aoju.bus.core.toolkit.FileKit;
import org.aoju.bus.core.toolkit.ObjectKit;

import java.io.IOException;
import java.nio.file.*;

/**
 * 文件移动封装
 *
 * @author Kimi Liu
 * @since Java 17+
 */
public class FileMover {

    /**
     * 源文件或目录
     */
    private final Path src;
    /**
     * 目标文件或目录
     */
    private final Path target;
    /**
     * 操作参数
     */
    private final CopyOption[] options;

    /**
     * 创建文件或目录移动器
     *
     * @param src        源文件或目录
     * @param target     目标文件或目录
     * @param isOverride 是否覆盖目标文件
     * @return {@code PathMover}
     */
    public static FileMover of(final Path src, final Path target, final boolean isOverride) {
        return of(src, target, isOverride ? new CopyOption[]{StandardCopyOption.REPLACE_EXISTING} : new CopyOption[]{});
    }

    /**
     * 创建文件或目录移动器
     *
     * @param src     源文件或目录
     * @param target  目标文件或目录
     * @param options 移动参数
     * @return {@code PathMover}
     */
    public static FileMover of(final Path src, final Path target, final CopyOption[] options) {
        return new FileMover(src, target, options);
    }

    /**
     * 构造
     *
     * @param src     源文件或目录，不能为{@code null}且必须存在
     * @param target  目标文件或目录
     * @param options 移动参数
     */
    public FileMover(final Path src, final Path target, final CopyOption[] options) {
        Assert.notNull(target, "Src path must be not null !");
        if (false == FileKit.exists(src, false)) {
            throw new IllegalArgumentException("Src path is not exist!");
        }
        this.src = src;
        this.target = Assert.notNull(target, "Target path must be not null !");
        this.options = ObjectKit.defaultIfNull(options, new CopyOption[]{});
    }

    /**
     * 移动文件或目录到目标中，例如：
     * <ul>
     *     <li>如果src和target为同一文件或目录，直接返回target</li>
     *     <li>如果src为文件，target为目录，则移动到目标目录下，存在同名文件则按照是否覆盖参数执行</li>
     *     <li>如果src为文件，target为文件，则按照是否覆盖参数执行</li>
     *     <li>如果src为文件，target为不存在的路径，则重命名源文件到目标指定的文件，如move("/a/b", "/c/d"), d不存在，则b变成d</li>
     *     <li>如果src为目录，target为文件，抛出{@link IllegalArgumentException}</li>
     *     <li>如果src为目录，target为目录，则将源目录及其内容移动到目标路径目录中，如move("/a/b", "/c/d")，结果为"/c/d/b"</li>
     *     <li>如果src为目录，target为不存在的路径，则重命名src到target，如move("/a/b", "/c/d")，结果为"/c/d/"，相当于b重命名为d</li>
     * </ul>
     *
     * @return 目标文件Path
     */
    public Path move() {
        final Path src = this.src;
        Path target = this.target;
        final CopyOption[] options = this.options;

        if (FileKit.isDirectory(target)) {
            // 创建子路径的情况，1是目标是目录，需要移动到目录下，2是目标不能存在，自动创建目录
            target = target.resolve(src.getFileName());
        }

        // target 不存在导致NoSuchFileException
        if (Files.exists(target) && FileKit.equals(src, target)) {
            // 当用户传入目标路径与源路径一致时，直接返回，否则会导致删除风险
            return target;
        }

        // 自动创建目标的父目录
        FileKit.mkParentDirs(target);
        try {
            return Files.move(src, target, options);
        } catch (final IOException e) {
            if (e instanceof FileAlreadyExistsException) {
                // 目标文件已存在，直接抛出异常
                throw new InternalException(e);
            }
            // 移动失败，可能是跨分区移动导致的，采用递归移动方式
            walkMove(src, target, options);
            // 移动后删除空目录
            FileKit.delete(src);
            return target;
        }
    }

    /**
     * 移动文件或目录内容到目标中，例如：
     * <ul>
     *     <li>如果src为文件，target为目录，则移动到目标目录下，存在同名文件则按照是否覆盖参数执行</li>
     *     <li>如果src为文件，target为文件，则按照是否覆盖参数执行</li>
     *     <li>如果src为文件，target为不存在的路径，则重命名源文件到目标指定的文件，如moveContent("/a/b", "/c/d"), d不存在，则b变成d</li>
     *     <li>如果src为目录，target为文件，抛出{@link IllegalArgumentException}</li>
     *     <li>如果src为目录，target为目录，则将源目录下的内容移动到目标路径目录中，源目录不删除</li>
     *     <li>如果src为目录，target为不存在的路径，则创建目标路径为目录，将源目录下的内容移动到目标路径目录中，源目录不删除</li>
     * </ul>
     *
     * @return 目标文件Path
     */
    public Path moveContent() {
        final Path src = this.src;
        if (FileKit.isExistsAndNotDirectory(target, false)) {
            // 文件移动调用move方法
            return move();
        }

        final Path target = this.target;
        if (FileKit.isExistsAndNotDirectory(target, false)) {
            // 目标不能为文件
            throw new IllegalArgumentException("Can not move dir content to a file");
        }

        // target 不存在导致NoSuchFileException
        if (FileKit.equals(src, target)) {
            // 当用户传入目标路径与源路径一致时，直接返回，否则会导致删除风险
            return target;
        }

        final CopyOption[] options = this.options;

        // 移动失败，可能是跨分区移动导致的，采用递归移动方式
        walkMove(src, target, options);
        return target;
    }

    /**
     * 递归移动
     *
     * @param src     源目录
     * @param target  目标目录
     * @param options 移动参数
     */
    private static void walkMove(final Path src, final Path target, final CopyOption... options) {
        try {
            // 移动源目录下的内容而不删除目录
            Files.walkFileTree(src, new MoveVisitor(src, target, options));
        } catch (final IOException e) {
            throw new InternalException(e);
        }
    }

}
